Description

I'd previously done this manually, but there are getting to be too many deployments, and different users care about different things, so this PR adds a general set of functions to generate graphical documentation of Balancer deployments, based on the information in this repo (mostly the README). It can be copied right to the public docs, or used internally, and shows the history of deployments (e.g., all versions of the weighted pool).

The script readme has full documentation. Essentially, there are three steps:

1. Parse the README to get a json of all deployments, and a list of all the "families" (i.e., products). It assumes a standard naming convention, which we mostly follow, but allows for overriding it if we deviate. (It does this for stable pools.)

2. Read the deployments JSON from the previous step, and generate a GraphViz .dot file with one or more families (from the index).

3. Generate an SVG from the .dot file, using GraphViz.

It's in Python instead of TS because I needed the GraphViz libraries, and CI supports GraphViz, if we want to eventually automate it.

See docs-v3 PR #305.

This includes examples of the output for pools (weighted-pool,stable-pool,v3-weighted-pool,v3-stable-pool), for ease of review; we might want to remove that before merging.

CI runs the first step, which always keeps deployments.json current (fails if something made it change). If this is too onerous, we can remove it.

Type of change

• Bug fix
• New feature
• Breaking change
• Dependency changes
• Code refactor / cleanup
• Documentation or wording changes
• Other

Checklist:

• The diff is legible and has no extraneous changes
• Complex code has been commented, including external interfaces
• [N/A] Tests are included for all code paths
• The base branch is either master, or there's a description of how to merge

Issue Resolution